/*
Copyright (c) 2009, Young Digital Planet SA
All rights reserved.

* Redistribution and use in source and binary forms, with or without 
  modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this 
  list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, 
  this list of conditions and the following disclaimer in the documentation 
  and/or other materials provided with the distribution.
* Neither the name of the Young Digital Planet SA nor the names of its 
  contributors may be used to endorse or promote products derived from this 
  software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
POSSIBILITY OF SUCH DAMAGE.
*/
package pl.ydp.utils
{
	/**
	 * Interface for classes which will operate on test state.
	 */	
	public interface IStateBuilder
	{
		/**
		 * Test state on which operations will be made.
		 */
		function set state(initialState:Object):void;
		function get state():Object;
		
		/**
		 * Returns empty test state.
		 * @return test state.
		 */
		function getEmptyState():Object;
		
		/**
		 * Returns empty page state.
		 * @return page state
		 */
		function getEmptyPageState():Object;
		
		/**
		 * Adds page state.
		 * @param page state to add.
		 * @return success of operation.
		 */
 	 	function addPageState(pageState:Object):Boolean;
 	 	
 	 	/**
 	 	 * Adds page state at given position.
 	 	 * @param page state to add.
 	 	 * @param index position where the state should be inserted.
 	 	 * @return success of operation.
 	 	 */
 	 	function addPageStateAt(pageState:Object, index:int):Boolean;
 	 	
 	 	/**
 	 	 * Gets page state from given position.
 	 	 * @param index position of the page for which state will be returned.
 	 	 * @return page state.
 	 	 */
 	 	function getPageStateAt(index:int):Object;
 	 	
 	 	/**
 	 	 * Removes page state from given position.
 	 	 * @param index position of the page for which state will be removed.
 	 	 * @return success of operation.
 	 	 */
 	 	function removePageStateAt(index:int):Boolean;
 	 	
 	 	/**
 	 	 * Moves page state on given position one position down.
 	 	 * @param index index of page which state will be moved.
 	 	 * @return success of operation.
 	 	 */
 	 	function movePageStateDown(index:int):Boolean;
 	 	
 	 	/**
 	 	 * Moves page state on given position one position up.
 	 	 * @param index index of page which state will be moved.
 	 	 * @return success of operation.
 	 	 */
 	 	function movePageStateUp(index:int):Boolean;
 	 	
 	 	/**
 	 	 * Moves page state from beginIndex to endIndex.
 	 	 * @param beginIndex index of page state to move.
 	 	 * @param endIndex positon where moved state should be inserted.
 	 	 * @return success of operation.
 	 	 */
 	 	function movePageStateTo(beginIndex:int, endIndex:int):Boolean;
 	 	
 	 	/**
 	 	 * Replaces page state on given index.
 	 	 * @param newPageState page state which will placed on given position.
 	 	 * @param index position where to place new page state.
 	 	 * @return success of operation.
 	 	 */
 	 	function replacePageStateAt(newPageState:Object, index:int):Boolean;
	}
}